<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Faiss: /data/users/matthijs/github_faiss/faiss/gpu/test/TestUtils.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Faiss
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_6b3ae6988449b0834e9596fad5d75199.html">gpu</a></li><li class="navelem"><a class="el" href="dir_43be364029218a94c5bcb5d8c78d7156.html">test</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">TestUtils.cpp</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2015-present, Facebook, Inc.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * This source code is licensed under the BSD+Patents license found in the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;</div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">// Copyright 2004-present Facebook. All Rights Reserved.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &quot;../test/TestUtils.h&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &quot;../../utils.h&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &lt;cmath&gt;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &lt;gtest/gtest.h&gt;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#include &lt;set&gt;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#include &lt;sstream&gt;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#include &lt;time.h&gt;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#include &lt;unordered_map&gt;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">namespace </span>faiss { <span class="keyword">namespace </span>gpu {</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="keyword">inline</span> <span class="keywordtype">float</span> relativeError(<span class="keywordtype">float</span> a, <span class="keywordtype">float</span> b) {</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;  <span class="keywordflow">return</span> std::abs(a - b) / (0.5f * (std::abs(a) + std::abs(b)));</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;}</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">// This seed is also used for the faiss float_rand API; in a test it</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">// is all within a single thread, so it is ok</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keywordtype">long</span> s_seed = 1;</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keywordtype">void</span> newTestSeed() {</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;  <span class="keyword">struct </span>timespec t;</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;  clock_gettime(CLOCK_REALTIME, &amp;t);</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;  setTestSeed(t.tv_nsec);</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;}</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="keywordtype">void</span> setTestSeed(<span class="keywordtype">long</span> seed) {</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;  printf(<span class="stringliteral">&quot;testing with random seed %ld\n&quot;</span>, seed);</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;  srand48(seed);</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;  s_seed = seed;</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;}</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="keywordtype">int</span> randVal(<span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b) {</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  EXPECT_GE(a, 0);</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;  EXPECT_LE(a, b);</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;  <span class="keywordflow">return</span> a + (lrand48() % (b + 1 - a));</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;}</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="keywordtype">bool</span> randBool() {</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;  <span class="keywordflow">return</span> randSelect&lt;bool&gt;({<span class="keyword">true</span>, <span class="keyword">false</span>});</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;}</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;std::vector&lt;float&gt; randVecs(<span class="keywordtype">size_t</span> num, <span class="keywordtype">size_t</span> dim) {</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;  std::vector&lt;float&gt; v(num * dim);</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;  <span class="keyword">static</span> <span class="keywordtype">bool</span> first = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;  faiss::float_rand(v.data(), v.size(), s_seed);</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;  <span class="comment">// unfortunately we generate separate sets of vectors, and don&#39;t</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;  <span class="comment">// want the same values</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;  ++s_seed;</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;  <span class="keywordflow">return</span> v;</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;}</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="keywordtype">void</span> compareIndices(<span class="keyword">const</span> std::vector&lt;float&gt;&amp; queryVecs,</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;                    <a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>&amp; refIndex,</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;                    <a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>&amp; testIndex,</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;                    <span class="keywordtype">int</span> numQuery, <span class="keywordtype">int</span> dim, <span class="keywordtype">int</span> k,</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;                    <span class="keyword">const</span> std::string&amp; configMsg,</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;                    <span class="keywordtype">float</span> maxRelativeError,</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;                    <span class="keywordtype">float</span> pctMaxDiff1,</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;                    <span class="keywordtype">float</span> pctMaxDiffN) {</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;  <span class="comment">// Compare</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;  std::vector&lt;float&gt; refDistance(numQuery * k, 0);</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;  std::vector&lt;faiss::Index::idx_t&gt; refIndices(numQuery * k, -1);</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;  refIndex.<a class="code" href="structfaiss_1_1Index.html#aced51b1ebc33c47ab3ae15ea906559a7">search</a>(numQuery, queryVecs.data(),</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;                  k, refDistance.data(), refIndices.data());</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;  std::vector&lt;float&gt; testDistance(numQuery * k, 0);</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;  std::vector&lt;faiss::Index::idx_t&gt; testIndices(numQuery * k, -1);</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;  testIndex.<a class="code" href="structfaiss_1_1Index.html#aced51b1ebc33c47ab3ae15ea906559a7">search</a>(numQuery, queryVecs.data(),</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;                   k, testDistance.data(), testIndices.data());</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;  faiss::gpu::compareLists(refDistance.data(),</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;                           refIndices.data(),</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;                           testDistance.data(),</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;                           testIndices.data(),</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;                           numQuery, k,</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;                           configMsg,</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;                           <span class="keyword">true</span>, <span class="keyword">false</span>, <span class="keyword">true</span>,</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;                           maxRelativeError, pctMaxDiff1, pctMaxDiffN);</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;}</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="keywordtype">void</span> compareIndices(<a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>&amp; refIndex,</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;                    <a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>&amp; testIndex,</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;                    <span class="keywordtype">int</span> numQuery, <span class="keywordtype">int</span> dim, <span class="keywordtype">int</span> k,</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;                    <span class="keyword">const</span> std::string&amp; configMsg,</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;                    <span class="keywordtype">float</span> maxRelativeError,</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;                    <span class="keywordtype">float</span> pctMaxDiff1,</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;                    <span class="keywordtype">float</span> pctMaxDiffN) {</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;  <span class="keyword">auto</span> queryVecs = faiss::gpu::randVecs(numQuery, dim);</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;  compareIndices(queryVecs,</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;                 refIndex,</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;                 testIndex,</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;                 numQuery, dim, k,</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;                 configMsg,</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;                 maxRelativeError,</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;                 pctMaxDiff1,</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;                 pctMaxDiffN);</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;}</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="keyword">inline</span> T lookup(<span class="keyword">const</span> T* p, <span class="keywordtype">int</span> i, <span class="keywordtype">int</span> j, <span class="keywordtype">int</span> <span class="comment">/*dim1*/</span>, <span class="keywordtype">int</span> dim2) {</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;  <span class="keywordflow">return</span> p[i * dim2 + j];</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;}</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="keywordtype">void</span> compareLists(<span class="keyword">const</span> <span class="keywordtype">float</span>* refDist,</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;                  <span class="keyword">const</span> <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a>* refInd,</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;                  <span class="keyword">const</span> <span class="keywordtype">float</span>* testDist,</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;                  <span class="keyword">const</span> <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a>* testInd,</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;                  <span class="keywordtype">int</span> dim1, <span class="keywordtype">int</span> dim2,</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;                  <span class="keyword">const</span> std::string&amp; configMsg,</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;                  <span class="keywordtype">bool</span> printBasicStats, <span class="keywordtype">bool</span> printDiffs, <span class="keywordtype">bool</span> assertOnErr,</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;                  <span class="keywordtype">float</span> maxRelativeError,</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;                  <span class="keywordtype">float</span> pctMaxDiff1,</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;                  <span class="keywordtype">float</span> pctMaxDiffN) {</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;</div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;  <span class="keywordtype">float</span> maxAbsErr = 0.0f;</div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; dim1 * dim2; ++i) {</div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;    maxAbsErr = std::max(maxAbsErr, std::abs(refDist[i] - testDist[i]));</div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;  }</div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;  <span class="keywordtype">int</span> numResults = dim1 * dim2;</div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;</div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;  <span class="comment">// query -&gt; {index -&gt; result position}</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;  std::vector&lt;std::unordered_map&lt;faiss::Index::idx_t, int&gt;&gt; refIndexMap;</div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> query = 0; query &lt; dim1; ++query) {</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;    std::unordered_map&lt;faiss::Index::idx_t, int&gt; indices;</div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;</div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;    <span class="keywordflow">for</span> (<span class="keywordtype">int</span> result = 0; result &lt; dim2; ++result) {</div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;      indices[lookup(refInd, query, result, dim1, dim2)] = result;</div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;    }</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;</div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;    refIndexMap.emplace_back(std::move(indices));</div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;  }</div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;  <span class="comment">// See how far off the indices are</span></div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;  <span class="comment">// Keep track of the difference for each entry</span></div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;  std::vector&lt;std::vector&lt;int&gt;&gt; indexDiffs;</div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;</div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;  <span class="keywordtype">int</span> diff1 = 0; <span class="comment">// index differs by 1</span></div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;  <span class="keywordtype">int</span> diffN = 0; <span class="comment">// index differs by &gt;1</span></div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;  <span class="keywordtype">int</span> diffInf = 0; <span class="comment">// index not found in the other</span></div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;  <span class="keywordtype">int</span> nonUniqueIndices = 0;</div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;</div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;  <span class="keywordtype">double</span> avgDiff = 0.0;</div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;  <span class="keywordtype">int</span> maxDiff = 0;</div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;  <span class="keywordtype">float</span> maxRelErr = 0.0f;</div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;</div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> query = 0; query &lt; dim1; ++query) {</div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;    std::vector&lt;int&gt; diffs;</div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;    std::set&lt;faiss::Index::idx_t&gt; uniqueIndices;</div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;</div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;    <span class="keyword">auto</span>&amp; indices = refIndexMap[query];</div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;    <span class="keywordflow">for</span> (<span class="keywordtype">int</span> result = 0; result &lt; dim2; ++result) {</div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;      <span class="keyword">auto</span> t = lookup(testInd, query, result, dim1, dim2);</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;</div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;      <span class="comment">// All indices reported within a query should be unique; this is</span></div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;      <span class="comment">// a serious error if is otherwise the case</span></div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;      <span class="keywordtype">bool</span> uniqueIndex = uniqueIndices.count(t) == 0;</div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;      <span class="keywordflow">if</span> (assertOnErr) {</div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;        EXPECT_TRUE(uniqueIndex) &lt;&lt; configMsg</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;                                 &lt;&lt; <span class="stringliteral">&quot; &quot;</span> &lt;&lt; query</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;                                 &lt;&lt; <span class="stringliteral">&quot; &quot;</span> &lt;&lt; result</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;                                 &lt;&lt; <span class="stringliteral">&quot; &quot;</span> &lt;&lt; t;</div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;      }</div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;</div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;      <span class="keywordflow">if</span> (!uniqueIndex) {</div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;        ++nonUniqueIndices;</div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;      } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;        uniqueIndices.insert(t);</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;      }</div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;</div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;      <span class="keyword">auto</span> it = indices.find(t);</div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;      <span class="keywordflow">if</span> (it != indices.end()) {</div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;        <span class="keywordtype">int</span> diff = std::abs(result - it-&gt;second);</div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;        diffs.push_back(diff);</div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;</div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;        <span class="keywordflow">if</span> (diff == 1) {</div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;          ++diff1;</div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;          maxDiff = std::max(diff, maxDiff);</div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;        } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (diff &gt; 1) {</div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;          ++diffN;</div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;          maxDiff = std::max(diff, maxDiff);</div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;        }</div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;</div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;        avgDiff += (double) diff;</div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;      } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;        ++diffInf;</div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;        diffs.push_back(-1);</div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;        <span class="comment">// don&#39;t count this for maxDiff</span></div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;      }</div>
<div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;</div>
<div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;      <span class="keyword">auto</span> refD = lookup(refDist, query, result, dim1, dim2);</div>
<div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;      <span class="keyword">auto</span> testD = lookup(testDist, query, result, dim1, dim2);</div>
<div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;</div>
<div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;      <span class="keywordtype">float</span> relErr = relativeError(refD, testD);</div>
<div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;</div>
<div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;      <span class="keywordflow">if</span> (assertOnErr) {</div>
<div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;        EXPECT_LE(relErr, maxRelativeError) &lt;&lt; configMsg</div>
<div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;                                            &lt;&lt; <span class="stringliteral">&quot; (&quot;</span> &lt;&lt; query &lt;&lt; <span class="stringliteral">&quot;, &quot;</span> &lt;&lt; result</div>
<div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;                                            &lt;&lt; <span class="stringliteral">&quot;) refD: &quot;</span> &lt;&lt; refD</div>
<div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;                                            &lt;&lt; <span class="stringliteral">&quot; testD: &quot;</span> &lt;&lt; testD;</div>
<div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;      }</div>
<div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;</div>
<div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;      maxRelErr = std::max(maxRelErr, relErr);</div>
<div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;    }</div>
<div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;</div>
<div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;    indexDiffs.emplace_back(std::move(diffs));</div>
<div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;  }</div>
<div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;</div>
<div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;  <span class="keywordflow">if</span> (assertOnErr) {</div>
<div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;    EXPECT_LE((<span class="keywordtype">float</span>) (diff1 + diffN + diffInf),</div>
<div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;              (<span class="keywordtype">float</span>) numResults * pctMaxDiff1) &lt;&lt; configMsg;</div>
<div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;</div>
<div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;    <span class="comment">// Don&#39;t count diffInf because that could be diff1 as far as we</span></div>
<div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;    <span class="comment">// know</span></div>
<div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;    EXPECT_LE((<span class="keywordtype">float</span>) diffN, (<span class="keywordtype">float</span>) numResults * pctMaxDiffN) &lt;&lt; configMsg;</div>
<div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;  }</div>
<div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;</div>
<div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;  avgDiff /= (double) numResults;</div>
<div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;</div>
<div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;  <span class="keywordflow">if</span> (printBasicStats) {</div>
<div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;    <span class="keywordflow">if</span> (!configMsg.empty()) {</div>
<div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;      printf(<span class="stringliteral">&quot;Config\n&quot;</span></div>
<div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;             <span class="stringliteral">&quot;----------------------------\n&quot;</span></div>
<div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;             <span class="stringliteral">&quot;%s\n&quot;</span>,</div>
<div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;             configMsg.c_str());</div>
<div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;    }</div>
<div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;</div>
<div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;    printf(<span class="stringliteral">&quot;Result error and differences\n&quot;</span></div>
<div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;           <span class="stringliteral">&quot;----------------------------\n&quot;</span></div>
<div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;           <span class="stringliteral">&quot;max abs diff %.7f rel diff %.7f\n&quot;</span></div>
<div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;           <span class="stringliteral">&quot;idx diff avg: %.5g max: %d\n&quot;</span></div>
<div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;           <span class="stringliteral">&quot;idx diff of 1:      %d (%.3f%% of queries)\n&quot;</span></div>
<div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;           <span class="stringliteral">&quot;idx diff of &gt;1:     %d (%.3f%% of queries)\n&quot;</span></div>
<div class="line"><a name="l00251"></a><span class="lineno">  251</span>&#160;           <span class="stringliteral">&quot;idx diff not found: %d (%.3f%% of queries)&quot;</span></div>
<div class="line"><a name="l00252"></a><span class="lineno">  252</span>&#160;           <span class="stringliteral">&quot; [typically a last element inversion]\n&quot;</span></div>
<div class="line"><a name="l00253"></a><span class="lineno">  253</span>&#160;           <span class="stringliteral">&quot;non-unique indices: %d (a serious error if &gt;0)\n&quot;</span>,</div>
<div class="line"><a name="l00254"></a><span class="lineno">  254</span>&#160;           maxAbsErr, maxRelErr,</div>
<div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;           avgDiff, maxDiff,</div>
<div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;           diff1, 100.0f * (<span class="keywordtype">float</span>) diff1 / (<span class="keywordtype">float</span>) numResults,</div>
<div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;           diffN, 100.0f * (<span class="keywordtype">float</span>) diffN / (<span class="keywordtype">float</span>) numResults,</div>
<div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;           diffInf, 100.0f * (<span class="keywordtype">float</span>) diffInf / (<span class="keywordtype">float</span>) numResults,</div>
<div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;           nonUniqueIndices);</div>
<div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160;  }</div>
<div class="line"><a name="l00261"></a><span class="lineno">  261</span>&#160;</div>
<div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;  <span class="keywordflow">if</span> (printDiffs) {</div>
<div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;    printf(<span class="stringliteral">&quot;differences:\n&quot;</span>);</div>
<div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;    printf(<span class="stringliteral">&quot;==================\n&quot;</span>);</div>
<div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;    <span class="keywordflow">for</span> (<span class="keywordtype">int</span> query = 0; query &lt; dim1; ++query) {</div>
<div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;      <span class="keywordflow">for</span> (<span class="keywordtype">int</span> result = 0; result &lt; dim2; ++result) {</div>
<div class="line"><a name="l00267"></a><span class="lineno">  267</span>&#160;        <span class="keywordtype">long</span> refI = lookup(refInd, query, result, dim1, dim2);</div>
<div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;        <span class="keywordtype">long</span> testI = lookup(testInd, query, result, dim1, dim2);</div>
<div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;</div>
<div class="line"><a name="l00270"></a><span class="lineno">  270</span>&#160;        <span class="keywordflow">if</span> (refI != testI) {</div>
<div class="line"><a name="l00271"></a><span class="lineno">  271</span>&#160;          <span class="keywordtype">float</span> refD = lookup(refDist, query, result, dim1, dim2);</div>
<div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160;          <span class="keywordtype">float</span> testD = lookup(testDist, query, result, dim1, dim2);</div>
<div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;</div>
<div class="line"><a name="l00274"></a><span class="lineno">  274</span>&#160;          <span class="keywordtype">float</span> maxDist = std::max(refD, testD);</div>
<div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;          <span class="keywordtype">float</span> delta = std::abs(refD - testD);</div>
<div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;</div>
<div class="line"><a name="l00277"></a><span class="lineno">  277</span>&#160;          <span class="keywordtype">float</span> relErr = delta / maxDist;</div>
<div class="line"><a name="l00278"></a><span class="lineno">  278</span>&#160;</div>
<div class="line"><a name="l00279"></a><span class="lineno">  279</span>&#160;          <span class="keywordflow">if</span> (refD == testD) {</div>
<div class="line"><a name="l00280"></a><span class="lineno">  280</span>&#160;            printf(<span class="stringliteral">&quot;(%d, %d [%d]) (ref %ld tst %ld dist ==)\n&quot;</span>,</div>
<div class="line"><a name="l00281"></a><span class="lineno">  281</span>&#160;                   query, result,</div>
<div class="line"><a name="l00282"></a><span class="lineno">  282</span>&#160;                   indexDiffs[query][result],</div>
<div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;                   refI, testI);</div>
<div class="line"><a name="l00284"></a><span class="lineno">  284</span>&#160;          } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00285"></a><span class="lineno">  285</span>&#160;            printf(<span class="stringliteral">&quot;(%d, %d [%d]) (ref %ld tst %ld abs %.8f &quot;</span></div>
<div class="line"><a name="l00286"></a><span class="lineno">  286</span>&#160;                   <span class="stringliteral">&quot;rel %.8f ref %a tst %a)\n&quot;</span>,</div>
<div class="line"><a name="l00287"></a><span class="lineno">  287</span>&#160;                   query, result,</div>
<div class="line"><a name="l00288"></a><span class="lineno">  288</span>&#160;                   indexDiffs[query][result],</div>
<div class="line"><a name="l00289"></a><span class="lineno">  289</span>&#160;                   refI, testI, delta, relErr, refD, testD);</div>
<div class="line"><a name="l00290"></a><span class="lineno">  290</span>&#160;          }</div>
<div class="line"><a name="l00291"></a><span class="lineno">  291</span>&#160;        }</div>
<div class="line"><a name="l00292"></a><span class="lineno">  292</span>&#160;      }</div>
<div class="line"><a name="l00293"></a><span class="lineno">  293</span>&#160;    }</div>
<div class="line"><a name="l00294"></a><span class="lineno">  294</span>&#160;  }</div>
<div class="line"><a name="l00295"></a><span class="lineno">  295</span>&#160;}</div>
<div class="line"><a name="l00296"></a><span class="lineno">  296</span>&#160;</div>
<div class="line"><a name="l00297"></a><span class="lineno">  297</span>&#160;} }</div>
<div class="ttc" id="structfaiss_1_1Index_html_a040c6aed1f224f3ea7bf58eebc0c31a4"><div class="ttname"><a href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a></div><div class="ttdeci">long idx_t</div><div class="ttdoc">all indices are this type </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00062">Index.h:62</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_aced51b1ebc33c47ab3ae15ea906559a7"><div class="ttname"><a href="structfaiss_1_1Index.html#aced51b1ebc33c47ab3ae15ea906559a7">faiss::Index::search</a></div><div class="ttdeci">virtual void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels) const =0</div></div>
<div class="ttc" id="structfaiss_1_1Index_html"><div class="ttname"><a href="structfaiss_1_1Index.html">faiss::Index</a></div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00060">Index.h:60</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
